Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a notebook containing example usage of the client #91

Open
wants to merge 2 commits into
base: v0.x.x
Choose a base branch
from

Conversation

camille-bouvy-frequenz
Copy link
Collaborator

No description provided.

@cwasicki
Copy link

cwasicki commented Jan 2, 2025

Looking at this I still think that this could be CLI tools, doesn't look to complicated. I think one tool per endpoint would be a simpler start.

Also I think we should add some pre-defined convenient constants for the EIC codes which gives DeliveryArea objects.

If you aim for merging this notebook:

  • the notebook should be in an example folder on top level
  • GRIDPOOL_ID can be a constant in the notebook set to some dummy value
  • Remove the cell output

@cwasicki
Copy link

cwasicki commented Jan 2, 2025

Does the client also offer a way to retrieve a list of public trades and continue streaming all subsequent trades?

@camille-bouvy-frequenz
Copy link
Collaborator Author

GRIDPOOL_ID can be a constant in the notebook set to some dummy value

Even if this would make the notebook fail?

@camille-bouvy-frequenz
Copy link
Collaborator Author

Looking at this I still think that this could be CLI tools, doesn't look to complicated. I think one tool per endpoint would be a simpler start.

Ok noted. Should we still merge this or rather not?

@cwasicki
Copy link

cwasicki commented Jan 6, 2025

Even if this would make the notebook fail?

Good point, not sure, could also be a single env file that sets variables read from environment. However,

Should we still merge this or rather not?

Do you think it's useful?

@camille-bouvy-frequenz
Copy link
Collaborator Author

camille-bouvy-frequenz commented Jan 7, 2025

However,

I recon part of your message is missing here?

Do you think it's useful?

Yea I'd say that for some clients it would be great to have.

@cwasicki
Copy link

cwasicki commented Jan 7, 2025

Yea I'd say that for some clients it would be great to have.

The problem I see with having examples and this notebook is to maintain both, former is not such a big problem but notebooks are not so nice to maintain. So I would only keep it if it has some benefits over the CLI tools, e.g. I think it can be good for documenting examples. But the current version is not really complete yet.

@camille-bouvy-frequenz
Copy link
Collaborator Author

notebooks are not so nice to maintain

True that's a good point. I won't merge this then. I started working on the CLI tools & am almost done. I'll create a new PR for it tonight or tomorrow.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
part:docs Affects the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants